<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>octant.extern.delaunay.triangulate.Triangulation</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="octant-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="octant-module.html">Package&nbsp;octant</a> ::
        <a href="octant.extern-module.html">Package&nbsp;extern</a> ::
        <a href="octant.extern.delaunay-module.html">Package&nbsp;delaunay</a> ::
        <a href="octant.extern.delaunay.triangulate-module.html">Module&nbsp;triangulate</a> ::
        Class&nbsp;Triangulation
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
      </table>
    </td>
  </tr>
</table>
<!-- ==================== TYPE DESCRIPTION ==================== -->
<h1 class="epydoc">type Triangulation</h1><p class="nomargin-top"><span class="codelink"><a href="octant.extern.delaunay.triangulate-pysrc.html#Triangulation">source&nbsp;code</a></span></p>
<pre class="base-tree">
object --+
         |
        <strong class="uidshort">Triangulation</strong>
</pre>

<hr />
<pre class="literalblock">
A Delaunay triangulation of points in a plane.

Triangulation(x, y)
x, y -- the coordinates of the points as 1-D arrays of floats

Let us make the following definitions:
    npoints = number of points input
    nedges = number of edges in the triangulation
    ntriangles = number of triangles in the triangulation

    point_id = an integer identifying a particular point (specifically, an
        index into x and y), range(0, npoints)
    edge_id = an integer identifying a particular edge, range(0, nedges)
    triangle_id = an integer identifying a particular triangle
        range(0, ntriangles)

Attributes: (all should be treated as read-only to maintain consistency)
  x, y -- the coordinates of the points as 1-D arrays of floats.

  circumcenters -- (ntriangles, 2) array of floats giving the (x,y)
    coordinates of the circumcenters of each triangle (indexed by a
    triangle_id).

  edge_db -- (nedges, 2) array of point_id's giving the points forming
    each edge in no particular order; indexed by an edge_id.

  triangle_nodes -- (ntriangles, 3) array of point_id's giving the points
    forming each triangle in counter-clockwise order; indexed by a
    triangle_id.

  triangle_neighbors -- (ntriangles, 3) array of triangle_id's giving the
    neighboring triangle; indexed by a triangle_id.

    The value can also be -1 meaning that that edge is on the convex hull of
    the points and there is no neighbor on that edge. The values are ordered
    such that triangle_neighbors[tri, i] corresponds with the edge
    *opposite* triangle_nodes[tri, i]. As such, these neighbors are also in
    counter-clockwise order.

  hull -- list of point_id's giving the nodes which form the convex hull
    of the point set. This list is sorted in counter-clockwise order.

</pre>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Instance Methods</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="octant.extern.delaunay.triangulate.Triangulation-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">x</span>,
        <span class="summary-sig-arg">y</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="octant.extern.delaunay.triangulate-pysrc.html#Triangulation.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="linear_extrapolator"></a><span class="summary-sig-name">linear_extrapolator</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">z</span>,
        <span class="summary-sig-arg">bbox</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">default_value</span>=<span class="summary-sig-default">nan</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="octant.extern.delaunay.triangulate-pysrc.html#Triangulation.linear_extrapolator">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="octant.extern.delaunay.triangulate.Triangulation-class.html#linear_interpolator" class="summary-sig-name">linear_interpolator</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">z</span>,
        <span class="summary-sig-arg">default_value</span>=<span class="summary-sig-default">nan</span>)</span><br />
      Get an object which can interpolate within the convex hull by
assigning a plane to each triangle.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="octant.extern.delaunay.triangulate-pysrc.html#Triangulation.linear_interpolator">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="nn_extrapolator"></a><span class="summary-sig-name">nn_extrapolator</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">z</span>,
        <span class="summary-sig-arg">bbox</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">default_value</span>=<span class="summary-sig-default">nan</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="octant.extern.delaunay.triangulate-pysrc.html#Triangulation.nn_extrapolator">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="octant.extern.delaunay.triangulate.Triangulation-class.html#nn_interpolator" class="summary-sig-name">nn_interpolator</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">z</span>,
        <span class="summary-sig-arg">default_value</span>=<span class="summary-sig-default">nan</span>)</span><br />
      Get an object which can interpolate within the convex hull by
the natural neighbors method.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="octant.extern.delaunay.triangulate-pysrc.html#Triangulation.nn_interpolator">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="octant.extern.delaunay.triangulate.Triangulation-class.html#node_graph" class="summary-sig-name">node_graph</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Return a graph of node_id's pointing to node_id's.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="octant.extern.delaunay.triangulate-pysrc.html#Triangulation.node_graph">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="prep_extrapolator"></a><span class="summary-sig-name">prep_extrapolator</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">z</span>,
        <span class="summary-sig-arg">bbox</span>=<span class="summary-sig-default">None</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="octant.extern.delaunay.triangulate-pysrc.html#Triangulation.prep_extrapolator">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">x</span>,
        <span class="sig-arg">y</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="octant.extern.delaunay.triangulate-pysrc.html#Triangulation.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  
  <dl class="fields">
    <dt>Overrides:
        object.__init__
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="linear_interpolator"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">linear_interpolator</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">z</span>,
        <span class="sig-arg">default_value</span>=<span class="sig-default">nan</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="octant.extern.delaunay.triangulate-pysrc.html#Triangulation.linear_interpolator">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Get an object which can interpolate within the convex hull by
assigning a plane to each triangle.

z -- an array of floats giving the known function values at each point
  in the triangulation.

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="nn_interpolator"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">nn_interpolator</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">z</span>,
        <span class="sig-arg">default_value</span>=<span class="sig-default">nan</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="octant.extern.delaunay.triangulate-pysrc.html#Triangulation.nn_interpolator">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Get an object which can interpolate within the convex hull by
the natural neighbors method.

z -- an array of floats giving the known function values at each point
  in the triangulation.

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="node_graph"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">node_graph</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="octant.extern.delaunay.triangulate-pysrc.html#Triangulation.node_graph">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Return a graph of node_id's pointing to node_id's.</p>
  <p>The arcs of the graph correspond to the edges in the 
  triangulation.</p>
  <p>{node_id: set([node_id, ...]), ...}</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="octant-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1
    on Tue May 20 16:56:04 2008
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
